Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: improve @connection docs #11314

Merged
merged 10 commits into from
Nov 7, 2023
Merged

docs: improve @connection docs #11314

merged 10 commits into from
Nov 7, 2023

Conversation

Meschreiber
Copy link
Contributor

@Meschreiber Meschreiber commented Oct 24, 2023 •
edited
Loading

This PR copyedits the @connection docs as requested by @andyrobertsio .

Checklist:

  • If this PR contains changes to the library itself (not necessary for e.g. docs updates), please include a changeset (see CONTRIBUTING.md)
  • If this PR is a new feature, please reference an issue where a consensus about the design was reached (not necessary for small changes)
  • Make sure all of the significant new logic is covered by tests

@changeset-bot
Copy link

changeset-bot bot commented Oct 24, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: 1b42ad9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Oct 24, 2023 •
edited
Loading

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 37.07 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 43.52 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production) 42.01 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 32.6 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production) 31.27 KB (0%)
import { ApolloProvider } from "dist/react/index.js" 1.22 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production) 1.21 KB (0%)
import { useQuery } from "dist/react/index.js" 4.28 KB (0%)
import { useQuery } from "dist/react/index.js" (production) 4.1 KB (0%)
import { useLazyQuery } from "dist/react/index.js" 4.59 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production) 4.41 KB (0%)
import { useMutation } from "dist/react/index.js" 2.54 KB (0%)
import { useMutation } from "dist/react/index.js" (production) 2.52 KB (0%)
import { useSubscription } from "dist/react/index.js" 2.24 KB (0%)
import { useSubscription } from "dist/react/index.js" (production) 2.2 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" 4.62 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production) 4.05 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" 4.14 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production) 3.56 KB (0%)
import { useReadQuery } from "dist/react/index.js" 3 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production) 2.94 KB (0%)
import { useFragment } from "dist/react/index.js" 2.09 KB (0%)
import { useFragment } from "dist/react/index.js" (production) 2.04 KB (0%)

@netlify
Copy link

netlify bot commented Oct 24, 2023 •
edited
Loading

✅ Deploy Preview for apollo-client-docs ready!

Name Link
🔨 Latest commit 1b42ad9
🔍 Latest deploy log https://app.netlify.com/sites/apollo-client-docs/deploys/654a941693aefe0008c6f05a
😎 Deploy Preview https://deploy-preview-11314--apollo-client-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Meschreiber Meschreiber requested a review from a team October 24, 2023 00:58
@Meschreiber Meschreiber marked this pull request as ready for review November 2, 2023 21:53
@Meschreiber Meschreiber requested a review from a team as a code owner November 2, 2023 21:53
@Meschreiber Meschreiber requested review from shorgi and benjamn and removed request for shorgi November 2, 2023 21:54
benjamn
benjamn approved these changes Nov 3, 2023
View reviewed changes
Copy link
Member

@benjamn benjamn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all seems accurate to me, but I added a comment about an equivalent keyArgs configuration, which saves having to (remember to) put @connection in multiple queries. Feel free to adapt that info as you see fit!

docs/source/caching/advanced-topics.mdx Show resolved Hide resolved
@Meschreiber Meschreiber merged commit 9c0afcc into main Nov 7, 2023
9 checks passed
@Meschreiber Meschreiber deleted the docs/update-connection-directive-docs branch November 7, 2023 20:06
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 8, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jerelmiller jerelmiller jerelmiller left review comments

@benjamn benjamn benjamn approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Meschreiber @benjamn @jerelmiller